/*
 * Copyright 2011 myTDev.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mytdev.commons.server;

import java.io.IOException;
import java.util.concurrent.TimeoutException;

/**
 * A server engine that can be used to create a Server<T>.
 * 
 * @author Yann D'Isanto
 */
public interface ServerEngine<T> {

    /**
     * Returns this server engine timeout.
     * @return this server engine timeout.
     * @throws IOException if an I/O error occurs.
     */
    int getTimeout() throws IOException;

    /**
     * Listens for a connection to be made to this server engine and accepts it. 
     * The method blocks until a connection is made then returns it.
     * @return the connection made.
     * @throws IOException if an I/O error occurs when waiting for a connection.
     * @throws TimeoutException if a timeout was previously set with setTimeout 
     * and the timeout has been reached.
     */
    T listen() throws IOException, TimeoutException;

    /**
     * Sets the specified timeout. A timeout of zero is interpreted as an infinite timeout.
     * @param timeout the specified timeout, in milliseconds.
     * @throws IOException if an I/O error occurs.
     */
    void setTimeout(int timeout) throws IOException;
}
